# Packages

This document showcases all the npm package information maintained by Rsbuild team.

## @rsbuild/core

![](https://img.shields.io/npm/v/@rsbuild/core?style=flat-square&colorA=564341&colorB=EDED91)

Rsbuild core package that provides CLI commands and build capabilities based on Rspack.

- [npm](https://npmjs.com/package/@rsbuild/core)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/core)
- [Documentation](/api/javascript-api/core)

## @rsbuild/plugin-react

![](https://img.shields.io/npm/v/@rsbuild/plugin-react?style=flat-square&colorA=564341&colorB=EDED91)

The React plugin provides support for React, integrating features such as JSX compilation and React Refresh.

- [npm](https://npmjs.com/package/@rsbuild/plugin-react)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-react)
- [Documentation](/plugins/list/plugin-react)

## @rsbuild/plugin-vue

![](https://img.shields.io/npm/v/@rsbuild/plugin-vue?style=flat-square&colorA=564341&colorB=EDED91)

Vue 3 plugin that provides support for Vue 3 Single-File Components (SFC).

- [npm](https://npmjs.com/package/@rsbuild/plugin-vue)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-vue)
- [Documentation](/plugins/list/plugin-vue)

## @rsbuild/plugin-vue-jsx

![](https://img.shields.io/npm/v/@rsbuild/plugin-vue-jsx?style=flat-square&colorA=564341&colorB=EDED91)

Vue 3 JSX plugin that provides support for Vue 3 JSX / TSX syntax.

- [npm](https://npmjs.com/package/@rsbuild/plugin-vue-jsx)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-vue-jsx)
- [Documentation](/plugins/list/plugin-vue-jsx)

## @rsbuild/plugin-vue2

![](https://img.shields.io/npm/v/@rsbuild/plugin-vue2?style=flat-square&colorA=564341&colorB=EDED91)

Vue 2 plugin that provides support for Vue 2 Single-File Components (SFC).

- [npm](https://npmjs.com/package/@rsbuild/plugin-vue2)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-vue2)
- [Documentation](/plugins/list/plugin-vue2)

## @rsbuild/plugin-vue2-jsx

![](https://img.shields.io/npm/v/@rsbuild/plugin-vue2-jsx?style=flat-square&colorA=564341&colorB=EDED91)

Vue 2 JSX plugin that provides support for Vue 2 JSX / TSX syntax.

- [npm](https://npmjs.com/package/@rsbuild/plugin-vue2-jsx)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-vue2-jsx)
- [Documentation](/plugins/list/plugin-vue2-jsx)

## @rsbuild/plugin-eslint

![](https://img.shields.io/npm/v/@rsbuild/plugin-eslint?style=flat-square&colorA=564341&colorB=EDED91)

The ESLint plugin is used to run ESLint checks during the compilation.

- [npm](https://npmjs.com/package/@rsbuild/plugin-eslint)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-eslint)
- [Documentation](/plugins/list/plugin-eslint)

## @rsbuild/plugin-type-check

![](https://img.shields.io/npm/v/@rsbuild/plugin-type-check?style=flat-square&colorA=564341&colorB=EDED91)

Type check plugin that runs TypeScript type checker on a separate process.

- [npm](https://npmjs.com/package/@rsbuild/plugin-type-check)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-type-check)
- [Documentation](/plugins/list/plugin-type-check)

## @rsbuild/plugin-typed-css-modules

![](https://img.shields.io/npm/v/@rsbuild/plugin-typed-css-modules?style=flat-square&colorA=564341&colorB=EDED91)

Generate TypeScript declaration files for CSS Modules in the project.

- [npm](https://npmjs.com/package/@rsbuild/plugin-typed-css-modules)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-typed-css-modules)
- [Documentation](/plugins/list/plugin-typed-css-modules)

## @rsbuild/plugin-source-build

![](https://img.shields.io/npm/v/@rsbuild/plugin-source-build?style=flat-square&colorA=564341&colorB=EDED91)

This plugin is designed for the monorepo scenario. It supports referencing source code from other subdirectories and performs build and hot update.

- [npm](https://npmjs.com/package/@rsbuild/plugin-source-build)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-source-build)
- [Documentation](/plugins/list/plugin-source-build)

## @rsbuild/plugin-sass

![](https://img.shields.io/npm/v/@rsbuild/plugin-sass?style=flat-square&colorA=564341&colorB=EDED91)

Sass plugin that uses Sass as the CSS preprocessor.

- [npm](https://npmjs.com/package/@rsbuild/plugin-sass)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-sass)
- [Documentation](/plugins/list/plugin-sass)

## @rsbuild/plugin-less

![](https://img.shields.io/npm/v/@rsbuild/plugin-less?style=flat-square&colorA=564341&colorB=EDED91)

Less plugin that uses Less as the CSS preprocessor.

- [npm](https://npmjs.com/package/@rsbuild/plugin-less)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-less)
- [Documentation](/plugins/list/plugin-less)

## @rsbuild/plugin-stylus

![](https://img.shields.io/npm/v/@rsbuild/plugin-stylus?style=flat-square&colorA=564341&colorB=EDED91)

Stylus plugin that uses Stylus as the CSS preprocessor.

- [npm](https://npmjs.com/package/@rsbuild/plugin-stylus)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-stylus)
- [Documentation](/plugins/list/plugin-stylus)

## @rsbuild/plugin-node-polyfill

![](https://img.shields.io/npm/v/@rsbuild/plugin-node-polyfill?style=flat-square&colorA=564341&colorB=EDED91)

Node Polyfill plugin used to inject polyfills for Node core modules in the browser.

- [npm](https://npmjs.com/package/@rsbuild/plugin-node-polyfill)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-node-polyfill)
- [Documentation](/plugins/list/plugin-node-polyfill)

## @rsbuild/plugin-image-compress

![](https://img.shields.io/npm/v/@rsbuild/plugin-image-compress?style=flat-square&colorA=564341&colorB=EDED91)

Image Compress plugin used to compress image resources used in the project.

- [npm](https://npmjs.com/package/@rsbuild/plugin-image-compress)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-image-compress)
- [Documentation](/plugins/list/plugin-image-compress)

## @rsbuild/plugin-mdx

![](https://img.shields.io/npm/v/@rsbuild/plugin-mdx?style=flat-square&colorA=564341&colorB=EDED91)

Provide support for MDX.

- [npm](https://npmjs.com/package/@rsbuild/plugin-mdx)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-mdx)
- [Documentation](/plugins/list/plugin-mdx)

## @rsbuild/plugin-check-syntax

![](https://img.shields.io/npm/v/@rsbuild/plugin-check-syntax?style=flat-square&colorA=564341&colorB=EDED91)

Check Syntax plugin used to analyze the syntax compatibility of artifacts, to see if there are any advanced syntaxes that may cause compatibility issues.

- [npm](https://npmjs.com/package/@rsbuild/plugin-check-syntax)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-check-syntax)
- [Documentation](/plugins/list/plugin-check-syntax)

## @rsbuild/plugin-pug

![](https://img.shields.io/npm/v/@rsbuild/plugin-pug?style=flat-square&colorA=564341&colorB=EDED91)

Provides support for the Pug template engine.

- [npm](https://npmjs.com/package/@rsbuild/plugin-pug)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-pug)
- [Documentation](/plugins/list/plugin-pug)

## @rsbuild/plugin-rem

![](https://img.shields.io/npm/v/@rsbuild/plugin-rem?style=flat-square&colorA=564341&colorB=EDED91)

Implements the rem adaptive layout for mobile pages.

- [npm](https://npmjs.com/package/@rsbuild/plugin-rem)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-rem)
- [Documentation](/plugins/list/plugin-rem)

## @rsbuild/plugin-umd

![](https://img.shields.io/npm/v/@rsbuild/plugin-umd?style=flat-square&colorA=564341&colorB=EDED91)

Used to build outputs in UMD format.

- [npm](https://npmjs.com/package/@rsbuild/plugin-umd)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-umd)
- [Documentation](/plugins/list/plugin-umd)

## @rsbuild/plugin-yaml

![](https://img.shields.io/npm/v/@rsbuild/plugin-yaml?style=flat-square&colorA=564341&colorB=EDED91)

Used to import YAML files and convert them into JavaScript objects.

- [npm](https://npmjs.com/package/@rsbuild/plugin-yaml)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-yaml)
- [Documentation](/plugins/list/plugin-yaml)

## @rsbuild/plugin-toml

![](https://img.shields.io/npm/v/@rsbuild/plugin-toml?style=flat-square&colorA=564341&colorB=EDED91)

Used to import TOML files and convert them into JavaScript objects.

- [npm](https://npmjs.com/package/@rsbuild/plugin-toml)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-toml)
- [Documentation](/plugins/list/plugin-toml)

## @rsbuild/plugin-assets-retry

![](https://img.shields.io/npm/v/@rsbuild/plugin-assets-retry?style=flat-square&colorA=564341&colorB=EDED91)

Used to automatically resend requests when static assets fail to load.

- [npm](https://npmjs.com/package/@rsbuild/plugin-assets-retry)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-assets-retry)
- [Documentation](/plugins/list/plugin-assets-retry)

## @rsbuild/plugin-basic-ssl

![](https://img.shields.io/npm/v/@rsbuild/plugin-basic-ssl?style=flat-square&colorA=564341&colorB=EDED91)

Generate an untrusted, self-signed certificate for the HTTPS server.

- [npm](https://npmjs.com/package/@rsbuild/plugin-basic-ssl)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/plugin-basic-ssl)
- [Documentation](/plugins/list/plugin-basic-ssl)

## @rsbuild/shared

![](https://img.shields.io/npm/v/@rsbuild/shared?style=flat-square&colorA=564341&colorB=EDED91)

Shared modules and helpers used internally by Rsbuild.

- [npm](https://npmjs.com/package/@rsbuild/shared)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/shared)

:::warning
The `@rsbuild/shared` is used internally by Rsbuild. Please avoid relying on the methods exported by `@rsbuild/shared` in web projects or community plugins.

If you need to use the methods in `@rsbuild/shared`, you can directly copy the relevant code into your project, or you can provide feedback through issues. We will evaluate whether there is a need to provide an external API.
:::

## @rsbuild/document

![](https://img.shields.io/npm/v/@rsbuild/document?style=flat-square&colorA=564341&colorB=EDED91)

Rsbuild documentation site.

- [npm](https://npmjs.com/package/@rsbuild/document)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/website)

## create-rsbuild

![](https://img.shields.io/npm/v/create-rsbuild?style=flat-square&colorA=564341&colorB=EDED91)

Used to create a new Rsbuild project.

- [npm](https://npmjs.com/package/create-rsbuild)
- [Source Code](https://github.com/web-infra-dev/rsbuild/tree/main/packages/create-rsbuild)
